BBS Toolkit/BBS Toolkit.iso/opus/phon3032.zip/OPCONFIG.HLP

Text File | 1992-10-19 | 10.7 KB | 270 lines

; Help file for OPConfig.exe
; started 9/13/92.
;
; Opening help for main options menu on opconfig.
;
; Special characters must _always_ start in column 1.
; Tags are defined with the ':' as the first character.
; A generic tag is a tag _without_ the menu location number after it.
; For example, :options will always be selected no matter where the
; menu select bar is, while :options00 will only be selected when
; the menu bar is on the top, or zeroeth, selection.
; Text is displayed between the first matching tag and the next in the
; text file or EOF, whichever comes first.
;
; Tags are defined as :tagname startx starty lengthx lengthy
; Be careful in defining the location and size, as the menu routines
; will back out one line above and below and one column to the right and
; left of the defined area. For example, an area defined as 2 2 5 5
; will actually consume a screen window starting at 1,1 that is 7 columns
; wide and 7 lines long to create an area 5 columns wide and 5 lines
; long.
;
; Highlighted text is delimited with the '@' and the '~' characters.
; @ - single character only. Used by menu functions to pick a select letter.
; ~ - multiple characters. Must be followed by a closing ~, as in ~highlight~.
;
; Opening generic help screen.
;
:options 4 5 72 17
Welcome to ~OPconfig~, the configuration program for ~OPhone~. This program
allows you to set up the various operating parameters for OPhone. With
this program you can select menu colors and local chat colors, control
various session parameters such as mouse use and automatic caller time
update, where various support files are located, when callers can page
you, and other parameters.

To move around the menus simply press the &Highlighted letter next to the
selection or move the menu select bar using the arrow keys, and then
press Enter. You can exit from menus back to this main menu by pressing
Escape.

One note on exiting this program. The Quit selection allows you to
quite without saving any changes. To save changes you have made select
Exit.

To exit from any help screen, press any keyboard key or mouse button.
;
; entries for menu text color changes
;
:tmcolors00 54 6 24 6
;0123456789+123456789+12
The border characters
are those line-drawing
characters that surround
the menu and also separ-
ate the menu into
groups.
:tmcolors01 54 6 24 9
;0123456789+123456789+12
Normal text is all text
printed in the menu box
that does not allow some
action selection. For
example, &Selection has
the &S highlighted and
the `election' normally
colored; you change the
color of this text.
:tmcolors02 54 6 24 8
;0123456789+123456789+12
Highlighted text are the
characters you press on
the keyboard to select
some function or another
menu. You change the
color of ~highlighted~
text with this selec-
tion.
:tmcolors04 54 6 24 8
;0123456789+123456789+12
The select bar is the
horizontal bar that
moves around the menus.
When cursoring around
the bar is displayed in
one color set, which you
change with this selec-
tion.
:tmcolors05 54 6 24 7
;0123456789+123456789+12
When you press Enter or
a select action, the
select bar changes to
another color to indi-
cate your selection.
You change that color
with this selection.
;
; changes for chat colors.
;
:tpcolors00 2 6 24 6
;0123456789+123456789+12
The text and background
in the upper window is
the sysop text. This
selection allows you to
change the colors for
this text.
:tpcolors01 2 6 24 6
;0123456789+123456789+12
The text and background
in the lower windows is
the caller text. This
selection allows you to
change the colors for
this text.
:tpcolors03 2 6 24 6
;0123456789+123456789+12
The labels are the words
printed on the 24th line
beneath the caller win-
dow, as well as the cal-
ler's name and the sys-
op's name.
:tpcolors04 2 6 24 5
;0123456789+123456789+12
The information text is
printed on the line be-
neath the caller's win-
dow, next to the label
text.
:tpcolors05 2 6 24 7
;0123456789+123456789+12
The multitasker text is
printed on the line im-
mediately above the sys-
op's text window, on the
left. It currently will
display Desqview or
Windows.
;
; entries for session control, opconfig.
;
:user_misc00 4 6 72 11
~Time adjust~ allows OPhone to add the time spent in chat to the time the
caller must be off the system. This keeps the chat time from  impacting
the total time a caller is allowed on line. When in manual, you can add
time to the caller's time  from  the  User  Record  Editor  menu.  When
in  auto,  this   is  done automatically.  Please  note  that when ~Time
~adjust~ is in auto, the time left, displayed on the lower right  corner,
is not updated. Also  note  that when you toggle  ~Time adjust~ from man-
ual to auto, that you also toggle ~Update user~ from manual to  auto.  It
makes no  sense  to  toggle one without toggling the other, and  OPcon-
fig does this for you. However, if you do not want ~Update user~ in auto,
you may then toggle ~Update user~ back to manual.
:user_misc01 4 6 72 6
&Update user allows OPhone to automatically write the user record back
out when OPhone exits. This is useful on those Opus systems configured
to read the user record back in again (see your Opus documentation for
further details). If you do not have  &Update  user in auto and you make
changes to the user record, you must  use  the  write  command  on  the
User Record Editor menu in Ophone to save your changes.
:user_misc02 4 6 72 8
~Caller ring~ allows you to block all caller  chat requests regardless of
the settings in your schedule file. You  can  set  this flag from the
command line with the "~phone block~" and "~phone  noblock~"  commands,  or
you can do it here.

~When open, callers can request a chat~ based on allowed chat times.
~When blocked, callers are always blocked~ regardless of allowed chat
times.
:user_misc03 4 6 72 3
~Verify quit~ turns on or off the verify button when you press ~ALT Q~ in
OPhone. If you don't want the hassle of being queried every time you
exit, then turn off this training wheel.
:user_misc04 4 6 72 3
~Mouse used~ enables the mouse or disables it. This is an old feature that
will probably disappear in later releases. If enabled, OPhone and
OPConfig will use a mouse if the programs detect a mouse driver.
:user_misc05 4 6 72 7
~Shell swap~ allows you to swap most of OPhone out to disk, EMS, or XMS
memory when you shell to DOS, thus  reclaiming all that memory for other
use. It allows you to shell on systems with tight memory constraints or
in  small multitasker partitions. If EMS or XMS is present, and if there
is enough, then all but about 1K is swapped out. If EMS is not present,
then it is swapped to a temp disk file at the root of the current disk.
~IF THIS FEATURE CAUSES PROBLEMS TURN IT OFF.
:phone_files00 4 6 72 6
The ~Abort file~ is the path and/or file name OPhone will execute if one
of the following occurs:
    a caller attempts to chat outside of the time limits;
    a caller is blocked by the sysop during a normal page attempt;
    a caller's name is in the block file;
    a caller's page times out during regular chat hours.
:phone_files01 4 6 72 13
The ~Block file~ is the path and/or file name OPhone will open to block
callers from chatting under any circumstances. While the ~block switch~
and the ~block calls~ selection in Session control can block all
callers, the block file can be used to target ~individual callers.~
The basic format of the block file are simple ascii strings, with one
name per line. For example

william h. beebe, jr.
joe user

Note that each name must begin in the first leftmost column. The names
should be spelled as they appear in your user file, but the search is
case insensitive.
:phone_files02 4 6 72 3
The ~Capture file~  is the path and/or file name OPhone will open on
startup. In this file is written the log of the current chat session,
as well as any captured conversation.
:phone_files06 4 6 72 6
The Lastuser file is the path and/or file  name  OPhone  will  read
in when it starts up. This  file is written out by Opus, and is of the
form LASTUS##.DAT, where  ~##~  is  the hexadecimal task number for that
instance  of  Opus.  The default string has the  internal  variables
~$S~ and ~$N~. OPhone will replace these with the Status subdirectory
and task number passed to  it  or read from the Opus parm file.
:phone_files08 4 6 72 3
The  ~Prm file~ is the path and/or file name OPhone will read in for
additional operating information. The PRM file is Opus' prime config-
uration file.
:phone_files09 4 6 72 9
The ~Status line~ is the path to  the  Opus  status  subdirectory.  This
is the subdirectory specified in the PRM file that points  to  where
Opus  puts its ACTIVE##.DAT and CHAT##.DAT  files  for  multiline  use.

~YOU MUST HAVE THIS PROPERLY FILED IN FOR MULTILINE OR SINGLELINE TO~
~WORK.~

You may choose to end the path line with or without a backward slash.
OPhone will add the slash if needed.
:alarms 8 11 42 6
The alarms ~Bells~, ~Phone~, ~Flynt~, and ~Dive~
allow you to set how OPhone will sound
when a caller pages you for chat.

Press return to select, or escape to quit
without changing the current selection.
:ring_times 2 3 76 20
This screen allows you to set allowable chat times in 1/2 hour increments.
The working area is the inner box with the hours running across the top and
the days running down the left side. Use the arrow keys to move the cursor
around in this box.

As you move around, you will see, in the lower right, the time that an
individual block controls, such as ~Sunday from 11:00 am to 11:30 am~. This
tells you what time and day this block controls. A block that allows chat-
ting and will sound an alarm looks like &■. A block that allows chat but is
silent looks like ■. If the block is clear, then remote chat is disabled.

Pressing the ~space bar~ toggles a block on or off. Holding down the space
bar allows you to clear whole sections of the day. Pressing &Q toggles the
sound page. &Clear all clears the entire day. &Set all allows chat with sound
paging for the entire day. &Duplicate copies the current day's settings to
all other days. And &Alarm type allows you to select what sound is generated
if a sound page is enabled for a given time block.

Pressing Enter will exit with all settings, while pressing escape or the
right mouse button will quit without saving your changes.
:colors 2 15 50 7
The two small windows you see help select text
colors for the ~menu~ or ~local chat~ colors. To
select a color combination move the cursor around
the palette box on the right. The colors will
change in the example window on the far left.
Press ~Enter~ to accept a combination or ~Escape~
to cancel.